Sourced from openapi-typescript's releases.

[email protected]

Major Changes

• 6d1eb32 Thanks @​drwpow! - ⚠️ Breaking: The Node.js API now returns the TypeScript AST for the main method as well as transform() and postTransform(). To migrate, you’ll have to use the typescript compiler API:

  + import ts from "typescript";
  
  
  const DATE = ts.factory.createIdentifier("Date");
  
  
  const NULL = ts.factory.createLiteralTypeNode(ts.factory.createNull());
  const ast = await openapiTS(mySchema, {
  transform(schemaObject, metadata) {
  if (schemaObject.format === "date-time") {
  
  
  
  
    return schemaObject.nullable ? "Date | null" : "Date";
  
  
  
  
  
    return schemaObject.nullable
  
  
  
      ? ts.factory.createUnionTypeNode([DATE, NULL])
  
  
  
      : DATE;
  }
  
  },
  };

Though it’s more verbose, it’s also more powerful, as now you have access to additional properties of the generated code you didn’t before (such as injecting comments).

For example syntax, search this codebae to see how the TypeScript AST is used.

Also see AST Explorer’s typescript parser to inspect how TypeScript is interpreted as an AST.

6d1eb32 Thanks @​drwpow! - ⚠️ Breaking: Changing of several CLI flags and Node.js API options

• The --auth, --httpHeaders, --httpMethod, and fetch (Node.js-only) options were all removed from the CLI and Node.js API
  • To migrate, you’ll need to create a redocly.yaml config that specifies your auth options in the http setting
  • You can also set your fetch client in redocly.yaml as well.
• --immutable-types has been renamed to --immutable
• --support-array-length has been renamed to --array-length

fbaf96d Thanks @​drwpow! - ⚠️ Breaking: Remove globbing schemas in favor of redocly.yaml config. Specify multiple schemas with outputs in there instead. See Multiple schemas for more info.

6d1eb32 Thanks @​drwpow! - ⚠️ Breaking: Most optional objects are now always present in types, just typed as :never. This includes keys of the Components Object as well as HTTP methods.

6d1eb32 Thanks @​drwpow! - ⚠️ Breaking: No more external export in schemas anymore. Everything gets flattened into the components object instead (if referencing a schema object from a remote partial, note it may have had a minor name change to avoid conflict).

6d1eb32 Thanks @​drwpow! - ⚠️ Breaking defaultNonNullable option now defaults to true. You’ll now need to manually set false to return to old behavior.

799194d Thanks @​drwpow~ - ⚠️ Breaking TypeScript is now a peerDependency and must be installed alongside openapi-typescript

Minor Changes

... (truncated)

Sourced from openapi-typescript's changelog.

7.0.0

Major Changes

• 6d1eb32 Thanks @​drwpow! - ⚠️ Breaking: The Node.js API now returns the TypeScript AST for the main method as well as transform() and postTransform(). To migrate, you’ll have to use the typescript compiler API:

  + import ts from "typescript";
  
  
  const DATE = ts.factory.createIdentifier("Date");
  
  
  const NULL = ts.factory.createLiteralTypeNode(ts.factory.createNull());
  const ast = await openapiTS(mySchema, {
  transform(schemaObject, metadata) {
  if (schemaObject.format === "date-time") {
  
  
  
  
    return schemaObject.nullable ? "Date | null" : "Date";
  
  
  
  
  
    return schemaObject.nullable
  
  
  
      ? ts.factory.createUnionTypeNode([DATE, NULL])
  
  
  
      : DATE;
  }
  
  },
  };

Though it’s more verbose, it’s also more powerful, as now you have access to additional properties of the generated code you didn’t before (such as injecting comments).

For example syntax, search this codebae to see how the TypeScript AST is used.

Also see AST Explorer’s typescript parser to inspect how TypeScript is interpreted as an AST.

6d1eb32 Thanks @​drwpow! - ⚠️ Breaking: Changing of several CLI flags and Node.js API options

• The --auth, --httpHeaders, --httpMethod, and fetch (Node.js-only) options were all removed from the CLI and Node.js API
  • To migrate, you’ll need to create a redocly.yaml config that specifies your auth options in the http setting
  • You can also set your fetch client in redocly.yaml as well.
• --immutable-types has been renamed to --immutable
• --support-array-length has been renamed to --array-length

fbaf96d Thanks @​drwpow! - ⚠️ Breaking: Remove globbing schemas in favor of redocly.yaml config. Specify multiple schemas with outputs in there instead. See Multiple schemas for more info.

6d1eb32 Thanks @​drwpow! - ⚠️ Breaking: Most optional objects are now always present in types, just typed as :never. This includes keys of the Components Object as well as HTTP methods.

6d1eb32 Thanks @​drwpow! - ⚠️ Breaking: No more external export in schemas anymore. Everything gets flattened into the components object instead (if referencing a schema object from a remote partial, note it may have had a minor name change to avoid conflict).

6d1eb32 Thanks @​drwpow! - ⚠️ Breaking defaultNonNullable option now defaults to true. You’ll now need to manually set false to return to old behavior.

799194d Thanks @​drwpow~ - ⚠️ Breaking TypeScript is now a peerDependency and must be installed alongside openapi-typescript

Minor Changes

... (truncated)

• d7494ba openapi-typescript@7, [email protected] 🎉 (#1706)
• 3845e55 Update repo (#1704)
• 2770a0b Update domain (#1703)
• 96bdf10 requestBody fields optional even with defaults (#1681)
• f6930af Clean up unnecessary files from npm package (#1671)
• bda737c Release Candidate (#1670)
• 054d564 Fix schema objects with default + nullable (#1669)
• a7dbe90 [email protected] (#1664)
• 6ea1b32 add flag for exporting enum value arrays #1616 (#1661)
• e4e099d fix: enums containing negative numbers (#1662)
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)